<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: net_flow/server_socket.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">server_socket.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="server__socket_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow__fwd_8hpp.html">flow/net_flow/net_flow_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="options_8hpp.html">flow/net_flow/options.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="log_8hpp.html">flow/log/log.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="linked__hash__set_8hpp.html">flow/util/linked_hash_set.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="util_2util_8hpp.html">flow/util/util.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow_2error_2error_8hpp.html">flow/net_flow/error/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &quot;<a class="code" href="shared__ptr__alias__holder_8hpp.html">flow/util/shared_ptr_alias_holder.hpp</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &lt;boost/unordered_set.hpp&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &lt;boost/enable_shared_from_this.hpp&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#include &lt;queue&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"></span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">/**</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * A server socket able to listen on a single Flow port for incoming connections and return peer</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * sockets (Peer_socket objects) to the local user once such connections are established.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * ### Life cycle of a Server_socket ###</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * A given Server_socket can only arise by calling Node::listen().</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * Node generates a new Server_socket and returns it (factory pattern).  Server_socket is not</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * instantiable otherwise.  A Server_socket cannot be deleted explicitly by the user and will only</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * be returned via `boost::shared_ptr&lt;&gt;`; when both the Node and all user code no longer refers to</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * it, the Server_socket will be destroyed.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * Once a Flow-protocol user has a Server_socket object, that object represents a socket in one of the</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * following basic states:</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *   - Listening.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *     - accept() may or may not return peer socket (&quot;Acceptable&quot;).</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *   - Closing.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *     - accept() will never return peer socket (never Acceptable).</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *   - Closed.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *     - accept() will never return peer socket (never Acceptable).</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * Exactly the following state transitions are possible for a given Server_socket returned by Node:</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *    - start =&gt; Listening</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *    - start =&gt; Closing</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> *    - start =&gt; Closed</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *    - Listening =&gt; Closing</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> *    - Listening =&gt; Closed</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *    - Closing =&gt; Closed</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * Note, in particular, that Closed is final; socket cannot move from Closed to Listening.  If after</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * an error or valid closing you want to reestablish a server, obtain a new Server_socket</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * from Node&#39;s factory.  Same rationale as for equivalent design decision in Peer_socket.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * Closing means either this side or other side initiated the closing of this server socket for any</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * reason, but Node is still finishing up operations related to that in the background (such as</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * closing in-progress peer connections).  Closed means Node has finished any such operations and</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * has disowned the Server_socket.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * In either case the only operation Server_socket supports (accept() and derivatives thereof) is</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * impossible in Closing and Closed.  Therefore the two states are distinguished for</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * diagnostic/informational purposes only.  Generally one should only accept() when Acceptable, and</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * accept() will return an error if the state is Closing or Closed.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> *</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * Note that a Closing or Closed Server_socket does NOT mean that already accept()ed Peer_socket objects</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * will be in any way affected.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * @todo Implement `Server_socket::close()` functionality -- at least the equivalent of</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * Peer_socket::close_abruptly().</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> *</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * ### Accept queue ###</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * Server_socket, like a TCP server socket, stores a queue of fully established peer</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * connections.  A Peer_socket is placed onto this internal queue only once its state() ==</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * State::S_OPEN (i.e., the connection handshake is finished/successful).  Peer_socket objects are then</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * obtained from this queue via the Server_socket::accept() call and its derivatives.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * ### Efficiently accept()ing ###</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * The sync_accept() method is efficient, in that it uses no processor</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * cycles until Acceptable is achieved (i.e., it sleeps until that point).  The non-blocking</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * accept() method doesn&#39;t sleep/block, however.  For a program using it to be efficient it should</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * sleep until Acceptable and only then call accept(), when a Peer_socket is certainly</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * available for immediate acceptance.  Moreover, a complex program is likely to want to perform</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> * this sleep-and-conditional-wake on a set of several Server_sockets (and/or other sockets)</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * simultaneously (similarly to `select()`, `epoll*()`, etc.).  Use class Event_set for this purpose.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * Same as for Node.  (Briefly: all operations safe for simultaneous execution on separate or the same object.)</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * Implementation notes</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * --------------------</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * See Peer_socket documentation header.  Similar comments apply here.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * To prevent node.cpp from being unmanageably large (and also because it makes sense),</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * implementations for Node methods that deal only with an individual Server_socket objects reside in</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * server_socket.cpp (even though they are members of Node, since, again, the logic is all forwarded to Node).</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * @todo Limit Server_socket listen queue/set length.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * @todo Rename `State` to `Phase`, as with similar to-do in class Peer_socket doc header.</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> */</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html">  118</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Server__socket.html">Server_socket</a> :</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Null__interface.html">util::Null_interface</a>,</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>  <span class="comment">// Endow us with shared_ptr&lt;&gt;s ::Ptr and ::Const_ptr (syntactic sugar).</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">util::Shared_ptr_alias_holder</a>&lt;boost::shared_ptr&lt;Server_socket&gt;&gt;,</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>  <span class="comment">// Allow access to Ptr(this) from inside Server_socket methods.  Just call shared_from_this().</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>  <span class="keyword">public</span> boost::enable_shared_from_this&lt;Server_socket&gt;,</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">log::Log_context</a>,</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>{</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"></span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">  /// State of a Server_socket.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a8bc789b851677a47d7c0a1aa0c69a997">  131</a></span><span class="comment"></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Server__socket.html#a8bc789b851677a47d7c0a1aa0c69a997">State</a></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">    /// Future or current accept()s may be possible.  A socket in this state may be Acceptable.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"></span>    S_LISTENING,<span class="comment"></span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">    /// No accept()s are or will be possible, but Node is still finishing up the closing operation.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"></span>    S_CLOSING,<span class="comment"></span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">    /// No accept()s are or will be possible, AND Node has disowned the Server_socket.</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"></span>    S_CLOSED</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>  };</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"></span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">  /// Equivalent to Peer_socket::Ptr, but can&#39;t use that due to C++&#39;s circular reference nonsense.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">  142</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">Peer_socket_ptr</a> = boost::shared_ptr&lt;Peer_socket&gt;;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"></span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">  /// Boring `virtual` destructor.  Note that deletion is to be handled exclusively via `shared_ptr`, never explicitly.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"></span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#acafb67ed1f81b90f3b2ab923de4e0525">~Server_socket</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"></span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   * Current State of the socket.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   * @return Current state of the socket.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">   */</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Server__socket.html#a8bc789b851677a47d7c0a1aa0c69a997">State</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#ab2683ecde1fac2b0a79a957de1a2a8ff">state</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"></span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">   * Node that produced this Server_socket.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">   * @return Pointer to (guaranteed valid) Node; 0 if state is S_CLOSED.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">   */</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>* <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#ae22e94978d59dfe23559a254349670bd">node</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"></span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">   * The local Flow-protocol port on which this server is or was listening.  For a given Server_socket, this</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">   * will always return the same value, even if CLOSED.  However, when CLOSED, the port may be</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">   * unused or taken by another socket.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">   *</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">   */</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>  <a class="code hl_typedef" href="namespaceflow_1_1net__flow.html#a079d8cd87a68d1c5f04c6bce71f0061d">flow_port_t</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#acd7b6b9c66eee2f3bbf35ac1068b1cb1">local_port</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"></span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">   * Non-blocking accept: obtain socket for the least recently established not-yet-obtained peer</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">   * connection on this server.  There is a queue (FIFO) of not-yet-claimed connections, and this</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment">   * returns the one at the front of the queue.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment">   *</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment">   * If state() is State::S_CLOSING or State::S_CLOSED (i.e., not State::S_LISTENING), this will return null (and an</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment">   * error), even if connections have been queued up.  Rationale: BSD sockets act similarly: cannot</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment">   * succeed with `accept(s)`, if `s` is not listening; also internal implementation is simpler.</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">   * Anti-rationale: our API is much more amenable to allowing accept()s in that situation; and it</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment">   * would mirror the fact that Peer_socket::receive() can succeed in `S_OPEN+S_DISCONNECTING` state.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">   * Why rationale &gt; anti-rationale: it&#39;s a judgment call, and I&#39;m going with simplicity of</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment">   * implementation at least for now.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   *</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">   * @todo Reconsider allowing successful accept() in State::S_CLOSING state?</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   *</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">   *        Note: no available connections is not, in itself, an error.  So it&#39;s quite possible for</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">   *        null to be returned but `*err_code` is success.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">   * @return A Peer_socket `sock` with `sock-&gt;state() == Peer_socket::State::S_OPEN`.  If no</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   *         connections are available (including if `bool(*err_code) == true`), returns null pointer.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   */</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">Peer_socket_ptr</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#aeea8554e23c8d743ca4956c772adbf24">accept</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"></span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment">   * Blocking (synchronous) version of accept().  Acts just like accept(), except that if `*this` is</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment">   * not immediately Acceptable (i.e., accept() would return null and no error), waits until it is</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment">   * Acceptable (accept() would return either non-null, or null and an error) and returns</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment">   * `accept(err_code)`.  In `reactor_pattern` mode (see arg doc), if it were to otherwise return a non-null</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">   * `Peer_socket::Ptr`, it instead leaves the ready peer socket available for subsequence acceptance and</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment">   * returns null.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment">   *</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   * If a timeout is specified, and this timeout expires before socket is</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   * Acceptable, acts like accept() executed on an un-Acceptable server socket.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   *</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   * These are the possible outcomes.</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   *   1. Connection succeeds before the given timeout expires (or succeeds, if no timeout given).</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   *      Socket is at least Writable at time of return.  If `!reactor_pattern` then the new socket is returned,</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   *      and no error is returned via `*err_code`; otherwise the socket is left available for acceptance, while</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   *      null is returned, and (similarly to non-reactor-pattern mode) no error is returned via `*err_code`.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   *   2. Connection fails before the given timeout expires (or fails, if no timeout given).  null</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   *      is returned, `*err_code` is set to reason for connection failure unless null.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">   *      (If `err_code` null, Runtime_error thrown.)  The code error::Code::S_WAIT_INTERRUPTED means the</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment">   *      wait was interrupted (similarly to POSIX&#39;s `EINTR`).</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment">   *   3. A user timeout is given, and the connection does not succeed before it expires.</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">   *      Output semantics are the same as in 2, with the specific code error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">   *      (Rationale: consistent with sync_receive(), sync_send() behavior.)</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   *</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   * Note that -- if `!reactor_pattern` -- it is NOT possible to return null and no error.</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   *</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   *</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   * @see The version of sync_accept() with no timeout.</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   *         See boost::chrono::duration documentation (and see above tip).</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">   *         See boost::chrono::duration documentation (and see above tip).</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   *        The maximum amount of time from now to wait before giving up on the wait and returning.</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` will eliminate the time limit and cause indefinite wait</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   *        (i.e., no timeout).</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   * @param reactor_pattern</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   *        If and only if `true`, and the call successfully waited until server socket became Acceptable, then</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   *        we return a null pointer and leave the peer socket ready to be accepted by the caller.  If `false`, then</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   *        in that same situation the socket is accepted and returned.  The parameter doesn&#39;t affect any other</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   *        situations.</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   * @return Reference-counted pointer to new Server_socket; or an empty pointer (essentially null).</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   *         Reminder that in `reactor_pattern` mode this may be null, yet indeed a socket is Acceptable</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   *         (the presence or lack of an error indicates whether that&#39;s the case).</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   */</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">Peer_socket_ptr</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a02ba529163a2d50132eff7aec9d9c9b8">sync_accept</a>(<span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>                              <span class="keywordtype">bool</span> reactor_pattern = <span class="keyword">false</span>,</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>                              <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment"></span> </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * Equivalent to `sync_accept(duration::max(), reactor_pattern, err_code)`; i.e., sync_accept() with no user</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * timeout.</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   *</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   *        See other sync_accept().</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   * @param reactor_pattern</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   *        See other sync_accept().</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * @return See other sync_accept().</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   */</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">Peer_socket_ptr</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a02ba529163a2d50132eff7aec9d9c9b8">sync_accept</a>(<span class="keywordtype">bool</span> reactor_pattern = <span class="keyword">false</span>, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment"></span> </div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   * The error code that perviously caused state() to become State::S_CLOSED, or success code if state</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   * is not CLOSED.  Note that once it returns non-success, the returned value subsequently will always be the same.</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   *</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   */</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span>  <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a6ba400221e347613c0d101b19602a3a2">disconnect_cause</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span> </div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment"></span> </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * Constructs object; initializes most values to well-defined (0, empty, etc.) but not necessarily</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   * meaningful values.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   *</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   * @param logger</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   *        The Logger implementation to use subsequently.</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   * @param child_sock_opts</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   *        Pointer to a per-socket options `struct` to copy and store; for each Peer_socket resulting</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   *        from this Server_socket, the options will be a copy of this copy.  If null pointer, then</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *        instead the enclosing Node&#39;s global per-socket options will be used to produce the</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   *        copy.</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   */</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a1f48a72439665d8754549f11a4f4c7bb">Server_socket</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger, <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* child_sock_opts);</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span> </div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span>  <span class="comment">// Friends.</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment"></span> </div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * See rationale for `friend`ing Node in class Server_socket documentation header.</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * @see Node.</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   */</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a6db9d28bd448a131448276ee03de1e6d">  295</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>;</div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span> </div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment"></span> </div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * Short-hand for reentrant mutex type.  We explicitly rely on reentrant behavior, so this isn&#39;t &quot;just in case.&quot;</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   *</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   * @todo This doc header for Server_socket::Mutex should specify what specific behavior requires mutex reentrance, so</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * that for example one could reevaluate whether there&#39;s a sleeker code pattern that would avoid it.</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   */</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a15e9fa900dfa1a0a2d693bf8ffb5b07d">  305</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a15e9fa900dfa1a0a2d693bf8ffb5b07d">Mutex</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a9c7a5df07c2e86c788de9e6bbaee77d5">util::Mutex_recursive</a>;</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"></span> </div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">  /// Short-hand for RAII lock guard of #Mutex.</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#ad428b65f60ee317aff7a0ad7f7a8f56d">  308</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#ad428b65f60ee317aff7a0ad7f7a8f56d">Lock_guard</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">util::Lock_guard&lt;Mutex&gt;</a>;</div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span> </div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span>  <span class="comment">/* Methods: as few as possible.  Logic should reside in class Node as discussed (though</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   * implementation may be in server_socket.cpp).  See rationale in class Server_socket</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   * documentation header. */</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"></span> </div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   * Same as sync_accept() but uses a #Fine_clock-based #Fine_duration non-template type</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   * for implementation convenience and to avoid code bloat to specify timeout.</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   *</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   *        See `sync_accept(timeout)`.  This is the absolute time point corresponding to that.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` maps to the value `Fine_time_pt()` (Epoch) for this argument.</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   * @param reactor_pattern</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   *        See sync_accept().</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   *        See sync_accept().</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   * @return See sync_accept().</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   */</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">Peer_socket_ptr</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a7f374375e95e008cfe0326ecfb27cf3b">sync_accept_impl</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until, <span class="keywordtype">bool</span> reactor_pattern, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span> </div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment"></span> </div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   * Either null or the pointer to a copy of the template Peer_socket_options intended for resulting</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   * Peer_socket objects.  Null means Peer_socket should use Node::options() as the template instead.</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   * Must be deleted in destructor if not null.</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   */</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a771900a26d8774a88f1f65b8910cf9d2">  337</a></span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a> <span class="keyword">const</span> * <span class="keyword">const</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#a771900a26d8774a88f1f65b8910cf9d2">m_child_sock_opts</a>;</div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment"></span> </div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">  /// See state().  Should be set before user gets access to `*this`.  Must not be modified by non-W threads.</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a783f81f10b50f62a638aa26b72d49e36">  340</a></span><span class="comment"></span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Server__socket.html#a8bc789b851677a47d7c0a1aa0c69a997">State</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#a783f81f10b50f62a638aa26b72d49e36">m_state</a>;</div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment"></span> </div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   * See node().  Should be set before user gets access to `*this` and not changed, except to 0 when</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   * state is S_CLOSED.  Must not be modified by non-W threads.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   */</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a8e8e3363803b2fe2c862b9fac1dfbb77">  346</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>* <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#a8e8e3363803b2fe2c862b9fac1dfbb77">m_node</a>;</div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment"></span> </div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   * See local_port().  Should be set before user gets access to `*this` and not changed afterwards.</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   * @todo Make #m_local_port `const`?</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   */</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#ac36eb28d50496b3f8f1b9790194e825e">  352</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1net__flow.html#a079d8cd87a68d1c5f04c6bce71f0061d">flow_port_t</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#ac36eb28d50496b3f8f1b9790194e825e">m_local_port</a>;</div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment"></span> </div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * Queue of passively opened sockets in Peer_socket::Int_state::S_ESTABLISHED internal state that have not yet been</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   * claimed by the user via `*accept()`.  `back()` is the next socket to be accepted (i.e., the one</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * that established connection longest ago).  This is not the more restricted `queue&lt;&gt;`,</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * because sometimes we want to remove things from the middle of it on error.  It is not a `list&lt;&gt;`, because</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * we sometimes (on error) need to erase items from the middle which requires a lookup by stored #Peer_socket_ptr</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * value which would be linear-time in a plain `list&lt;&gt;`.</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * Write-accessible from thread W and user threads (in `accept()`) and must be protected by a mutex.</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * @see Peer_socket::m_originating_serv for the closely related inverse.</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   */</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a7ba32040008ffe0637d3a1847deb76c5">  366</a></span>  <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__set.html">util::Linked_hash_set&lt;Peer_socket_ptr&gt;</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#a7ba32040008ffe0637d3a1847deb76c5">m_unaccepted_socks</a>;</div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment"></span> </div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   * The #Error_code causing this server&#39;s move from LISTENING state (if this has occurred); otherwise a</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * clear (success) #Error_code.  This starts as success and may move to one non-success value</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   * and then never change after that.  Graceful closing of the server via `close()` is indeed counted as a</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   * non-success value for #m_disconnect_cause.</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   *</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * As in TCP net-stacks, one cannot recover from a transmission error or termination on the socket</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * (the &quot;error&quot; `EWOULDBLOCK`/`EAGAIN` does not count), which is why this can only go from success -&gt;</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * non-success and never change after that.  (boost.asio error would be `would_block` or `try_again` when</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * I said `EWOUDLBLOCK`/`EAGAIN` informally there.)</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   *</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * How to report this to the user: attempting to `*accept()` or other operations while</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * #m_disconnect_cause is not success =&gt; the operation returns this #Error_code to the user.</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   * Note that even already queued acceptable sockets (#m_unaccepted_socks) will no longer be</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * available for acceptance.</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   *</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * This should be success in LISTENING state and failure otherwise.</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   *</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   * Since user threads will access this at least via accept(), while thread W may</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   * set it when implementing the server socket close, this must be protected by a mutex.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   */</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#ae87a97dcfaa0909789b76ef4462d6a0b">  390</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#ae87a97dcfaa0909789b76ef4462d6a0b">m_disconnect_cause</a>;</div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment"></span> </div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * This object&#39;s mutex.  The protected items are #m_state, #m_node,</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * #m_unaccepted_socks, `sock-&gt;m_originating_serv` for each `sock` in #m_unaccepted_socks, and</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * #m_disconnect_cause.</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   */</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a40967c1981ffde4f7b75c6bb5e5b279b">  397</a></span>  <span class="keyword">mutable</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a15e9fa900dfa1a0a2d693bf8ffb5b07d">Mutex</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#a40967c1981ffde4f7b75c6bb5e5b279b">m_mutex</a>;</div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment"></span> </div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * Set of passively opening sockets in pre-ESTABLISHED (so SYN_RCVD?) internal state (and thus</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   * are not yet ready to be given out via `*accept()`).  This gains meaning only in thread W.  This</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   * should NOT be accessed outside of thread W and is not protected my a mutex.</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   * Once a socket is acceptable (ESTABLISHED), it is moved from this to #m_unaccepted_socks, where</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   * it can be claimed by the user.  Thus the user never accesses this, and it is maintained by</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   * thread W only.</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   *</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">   * @see Peer_socket::m_originating_serv for the closely related inverse.</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   */</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a16bcbf9951c24d13d5b84d9aa163288e">  410</a></span>  boost::unordered_set&lt;Peer_socket_ptr&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Server__socket.html#a16bcbf9951c24d13d5b84d9aa163288e">m_connecting_socks</a>;</div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span>}; <span class="comment">// class Server_socket</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span> </div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span> </div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">// However the following refer to inner type(s) and hence must be declared here and not _fwd.hpp.</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment"></span> </div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">/**</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment"> * Prints string representation of given socket state to given standard `ostream` and returns the</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment"> * latter.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment"> *</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment"> * @relatesalso Server_socket</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment"> *</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment"> *        Stream to print to.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment"> * @param state</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment"> *        Value to serialize.</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment"> */</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span>std::ostream&amp; <a class="code hl_function" href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">operator&lt;&lt;</a>(std::ostream&amp; os, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Server__socket.html#a8bc789b851677a47d7c0a1aa0c69a997">Server_socket::State</a> state);</div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span> </div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span> </div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Server__socket.html#a02ba529163a2d50132eff7aec9d9c9b8">  434</a></span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">Server_socket::Peer_socket_ptr</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a02ba529163a2d50132eff7aec9d9c9b8">Server_socket::sync_accept</a>(<span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span>                                                          <span class="keywordtype">bool</span> reactor_pattern, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span>{</div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span>  assert(max_wait.count() &gt; 0);</div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Server__socket.html#a7f374375e95e008cfe0326ecfb27cf3b">sync_accept_impl</a>(<a class="code hl_function" href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">util::chrono_duration_from_now_to_fine_time_pt</a>(max_wait), reactor_pattern, err_code);</div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span>}</div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span> </div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span>} <span class="comment">// namespace flow::net_flow</span></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html">flow::net_flow::Node</a></div><div class="ttdoc">An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l00930">node.hpp:934</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html">flow::net_flow::Server_socket</a></div><div class="ttdoc">A server socket able to listen on a single Flow port for incoming connections and return peer sockets...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00118">server_socket.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a02ba529163a2d50132eff7aec9d9c9b8"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a02ba529163a2d50132eff7aec9d9c9b8">flow::net_flow::Server_socket::sync_accept</a></div><div class="ttdeci">Peer_socket_ptr sync_accept(const boost::chrono::duration&lt; Rep, Period &gt; &amp;max_wait, bool reactor_pattern=false, Error_code *err_code=0)</div><div class="ttdoc">Blocking (synchronous) version of accept().</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00434">server_socket.hpp:434</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a15e9fa900dfa1a0a2d693bf8ffb5b07d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a15e9fa900dfa1a0a2d693bf8ffb5b07d">flow::net_flow::Server_socket::Mutex</a></div><div class="ttdeci">util::Mutex_recursive Mutex</div><div class="ttdoc">Short-hand for reentrant mutex type.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00305">server_socket.hpp:305</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a16bcbf9951c24d13d5b84d9aa163288e"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a16bcbf9951c24d13d5b84d9aa163288e">flow::net_flow::Server_socket::m_connecting_socks</a></div><div class="ttdeci">boost::unordered_set&lt; Peer_socket_ptr &gt; m_connecting_socks</div><div class="ttdoc">Set of passively opening sockets in pre-ESTABLISHED (so SYN_RCVD?) internal state (and thus are not y...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00410">server_socket.hpp:410</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a1f48a72439665d8754549f11a4f4c7bb"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a1f48a72439665d8754549f11a4f4c7bb">flow::net_flow::Server_socket::Server_socket</a></div><div class="ttdeci">Server_socket(log::Logger *logger, const Peer_socket_options *child_sock_opts)</div><div class="ttdoc">Constructs object; initializes most values to well-defined (0, empty, etc.) but not necessarily meani...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00030">server_socket.cpp:30</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a3bc28900b6854a425ea33a192eda8252"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a3bc28900b6854a425ea33a192eda8252">flow::net_flow::Server_socket::Peer_socket_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Peer_socket &gt; Peer_socket_ptr</div><div class="ttdoc">Equivalent to Peer_socket::Ptr, but can't use that due to C++'s circular reference nonsense.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00142">server_socket.hpp:142</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a40967c1981ffde4f7b75c6bb5e5b279b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a40967c1981ffde4f7b75c6bb5e5b279b">flow::net_flow::Server_socket::m_mutex</a></div><div class="ttdeci">Mutex m_mutex</div><div class="ttdoc">This object's mutex.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00397">server_socket.hpp:397</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a6ba400221e347613c0d101b19602a3a2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a6ba400221e347613c0d101b19602a3a2">flow::net_flow::Server_socket::disconnect_cause</a></div><div class="ttdeci">Error_code disconnect_cause() const</div><div class="ttdoc">The error code that perviously caused state() to become State::S_CLOSED, or success code if state is ...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00064">server_socket.cpp:64</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a771900a26d8774a88f1f65b8910cf9d2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a771900a26d8774a88f1f65b8910cf9d2">flow::net_flow::Server_socket::m_child_sock_opts</a></div><div class="ttdeci">Peer_socket_options const  *const m_child_sock_opts</div><div class="ttdoc">Either null or the pointer to a copy of the template Peer_socket_options intended for resulting Peer_...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00337">server_socket.hpp:337</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a783f81f10b50f62a638aa26b72d49e36"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a783f81f10b50f62a638aa26b72d49e36">flow::net_flow::Server_socket::m_state</a></div><div class="ttdeci">State m_state</div><div class="ttdoc">See state(). Should be set before user gets access to *this. Must not be modified by non-W threads.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00340">server_socket.hpp:340</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a7ba32040008ffe0637d3a1847deb76c5"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a7ba32040008ffe0637d3a1847deb76c5">flow::net_flow::Server_socket::m_unaccepted_socks</a></div><div class="ttdeci">util::Linked_hash_set&lt; Peer_socket_ptr &gt; m_unaccepted_socks</div><div class="ttdoc">Queue of passively opened sockets in Peer_socket::Int_state::S_ESTABLISHED internal state that have n...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00366">server_socket.hpp:366</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a7f374375e95e008cfe0326ecfb27cf3b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a7f374375e95e008cfe0326ecfb27cf3b">flow::net_flow::Server_socket::sync_accept_impl</a></div><div class="ttdeci">Peer_socket_ptr sync_accept_impl(const Fine_time_pt &amp;wait_until, bool reactor_pattern, Error_code *err_code)</div><div class="ttdoc">Same as sync_accept() but uses a Fine_clock-based Fine_duration non-template type for implementation ...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00100">server_socket.cpp:100</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a8bc789b851677a47d7c0a1aa0c69a997"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a8bc789b851677a47d7c0a1aa0c69a997">flow::net_flow::Server_socket::State</a></div><div class="ttdeci">State</div><div class="ttdoc">State of a Server_socket.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00131">server_socket.hpp:132</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a8e8e3363803b2fe2c862b9fac1dfbb77"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a8e8e3363803b2fe2c862b9fac1dfbb77">flow::net_flow::Server_socket::m_node</a></div><div class="ttdeci">Node * m_node</div><div class="ttdoc">See node().</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00346">server_socket.hpp:346</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_ab2683ecde1fac2b0a79a957de1a2a8ff"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#ab2683ecde1fac2b0a79a957de1a2a8ff">flow::net_flow::Server_socket::state</a></div><div class="ttdeci">State state() const</div><div class="ttdoc">Current State of the socket.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00052">server_socket.cpp:52</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_ac36eb28d50496b3f8f1b9790194e825e"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#ac36eb28d50496b3f8f1b9790194e825e">flow::net_flow::Server_socket::m_local_port</a></div><div class="ttdeci">flow_port_t m_local_port</div><div class="ttdoc">See local_port().</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00352">server_socket.hpp:352</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_acafb67ed1f81b90f3b2ab923de4e0525"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#acafb67ed1f81b90f3b2ab923de4e0525">flow::net_flow::Server_socket::~Server_socket</a></div><div class="ttdeci">~Server_socket() override</div><div class="ttdoc">Boring virtual destructor. Note that deletion is to be handled exclusively via shared_ptr,...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00045">server_socket.cpp:45</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_acd7b6b9c66eee2f3bbf35ac1068b1cb1"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#acd7b6b9c66eee2f3bbf35ac1068b1cb1">flow::net_flow::Server_socket::local_port</a></div><div class="ttdeci">flow_port_t local_port() const</div><div class="ttdoc">The local Flow-protocol port on which this server is or was listening.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00070">server_socket.cpp:70</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_ad428b65f60ee317aff7a0ad7f7a8f56d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#ad428b65f60ee317aff7a0ad7f7a8f56d">flow::net_flow::Server_socket::Lock_guard</a></div><div class="ttdeci">util::Lock_guard&lt; Mutex &gt; Lock_guard</div><div class="ttdoc">Short-hand for RAII lock guard of Mutex.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00308">server_socket.hpp:308</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_ae22e94978d59dfe23559a254349670bd"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#ae22e94978d59dfe23559a254349670bd">flow::net_flow::Server_socket::node</a></div><div class="ttdeci">Node * node() const</div><div class="ttdoc">Node that produced this Server_socket.</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00058">server_socket.cpp:58</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_ae87a97dcfaa0909789b76ef4462d6a0b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#ae87a97dcfaa0909789b76ef4462d6a0b">flow::net_flow::Server_socket::m_disconnect_cause</a></div><div class="ttdeci">Error_code m_disconnect_cause</div><div class="ttdoc">The Error_code causing this server's move from LISTENING state (if this has occurred); otherwise a cl...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00390">server_socket.hpp:390</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_aeea8554e23c8d743ca4956c772adbf24"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#aeea8554e23c8d743ca4956c772adbf24">flow::net_flow::Server_socket::accept</a></div><div class="ttdeci">Peer_socket_ptr accept(Error_code *err_code=0)</div><div class="ttdoc">Non-blocking accept: obtain socket for the least recently established not-yet-obtained peer connectio...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00075">server_socket.cpp:75</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__set_html"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__set.html">flow::util::Linked_hash_set&lt; Peer_socket_ptr &gt;</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Null__interface_html"><div class="ttname"><a href="classflow_1_1util_1_1Null__interface.html">flow::util::Null_interface</a></div><div class="ttdoc">An empty interface, consisting of nothing but a default virtual destructor, intended as a boiler-plat...</div><div class="ttdef"><b>Definition:</b> <a href="util_2util_8hpp_source.html#l00044">util.hpp:45</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Shared__ptr__alias__holder_html"><div class="ttname"><a href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">flow::util::Shared_ptr_alias_holder</a></div><div class="ttdoc">Convenience class template that endows the given subclass T with nested aliases Ptr and Const_ptr ali...</div><div class="ttdef"><b>Definition:</b> <a href="shared__ptr__alias__holder_8hpp_source.html#l00119">shared_ptr_alias_holder.hpp:120</a></div></div>
<div class="ttc" id="alinked__hash__set_8hpp_html"><div class="ttname"><a href="linked__hash__set_8hpp.html">linked_hash_set.hpp</a></div></div>
<div class="ttc" id="alog_8hpp_html"><div class="ttname"><a href="log_8hpp.html">log.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html"><div class="ttname"><a href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div><div class="ttdoc">Flow module containing the API and implementation of the Flow network protocol, a TCP-inspired stream...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_a079d8cd87a68d1c5f04c6bce71f0061d"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#a079d8cd87a68d1c5f04c6bce71f0061d">flow::net_flow::flow_port_t</a></div><div class="ttdeci">uint16_t flow_port_t</div><div class="ttdoc">Logical Flow port type (analogous to a UDP/TCP port in spirit but in no way relevant to UDP/TCP).</div><div class="ttdef"><b>Definition:</b> <a href="net__flow__fwd_8hpp_source.html#l00054">net_flow_fwd.hpp:54</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_ab9f537c84f77e9b8fa742fc5dc6d5693"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">flow::net_flow::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Congestion_control_selector::Strategy_choice &amp;strategy_choice)</div><div class="ttdoc">Serializes a Peer_socket_options::Congestion_control_strategy_choice enum to a standard ostream – the...</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl_8cpp_source.html#l00146">cong_ctl.cpp:146</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a5488415feb5570a6551892a7bdfeeec4"><div class="ttname"><a href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">flow::util::chrono_duration_from_now_to_fine_time_pt</a></div><div class="ttdeci">Fine_time_pt chrono_duration_from_now_to_fine_time_pt(const boost::chrono::duration&lt; Rep, Period &gt; &amp;dur)</div><div class="ttdoc">Helper that takes a non-negative duration of arbitrary precision/period and converts it to Fine_durat...</div><div class="ttdef"><b>Definition:</b> <a href="util_2detail_2util_8hpp_source.html#l00042">util.hpp:42</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a5d2247b715da63e4b960909561b90ae7"><div class="ttname"><a href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">flow::util::Lock_guard</a></div><div class="ttdeci">boost::unique_lock&lt; Mutex &gt; Lock_guard</div><div class="ttdoc">Short-hand for advanced-capability RAII lock guard for any mutex, ensuring exclusive ownership of tha...</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00265">util_fwd.hpp:265</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a9c7a5df07c2e86c788de9e6bbaee77d5"><div class="ttname"><a href="namespaceflow_1_1util.html#a9c7a5df07c2e86c788de9e6bbaee77d5">flow::util::Mutex_recursive</a></div><div class="ttdeci">boost::recursive_mutex Mutex_recursive</div><div class="ttdoc">Short-hand for reentrant, exclusive mutex.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00218">util_fwd.hpp:218</a></div></div>
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00508">common.hpp:508</a></div></div>
<div class="ttc" id="anamespaceflow_html_a9d9cc2eeb10d398cff5591d446b763b8"><div class="ttname"><a href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">flow::Fine_time_pt</a></div><div class="ttdeci">Fine_clock::time_point Fine_time_pt</div><div class="ttdoc">A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00413">common.hpp:413</a></div></div>
<div class="ttc" id="anet__flow_2error_2error_8hpp_html"><div class="ttname"><a href="net__flow_2error_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anet__flow__fwd_8hpp_html"><div class="ttname"><a href="net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
<div class="ttc" id="aoptions_8hpp_html"><div class="ttname"><a href="options_8hpp.html">options.hpp</a></div></div>
<div class="ttc" id="ashared__ptr__alias__holder_8hpp_html"><div class="ttname"><a href="shared__ptr__alias__holder_8hpp.html">shared_ptr_alias_holder.hpp</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket__options_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket__options.html">flow::net_flow::Peer_socket_options</a></div><div class="ttdoc">A set of low-level options affecting a single Peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="options_8hpp_source.html#l00035">options.hpp:36</a></div></div>
<div class="ttc" id="autil_2util_8hpp_html"><div class="ttname"><a href="util_2util_8hpp.html">util.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
